/*Copyright (C) 2009 Careil Baptiste

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
//
///////////////////////////////////////////////////////////
/// \file Input.h Ce fichier contient les principales fonctions qui
/// interagissent avec les entrées.
///////////////////////////////////////////////////////////
#ifndef CSLP_INPUT_HEADER
# define CSLP_INPUT_HEADER

# include "dll.h"
# include "System.h"

# ifdef __cplusplus
extern "C" {
# endif /* __cplusplus */


  ///////////////////////////////////////////////////////////
  /// Permet de surveiller la pression d'une touche par l'utilisateur.\n
  /// Lire l'entrée stdin entre un appelle CSLP_PollChar() et CSLP_GetChar()
  /// a un comportement indéfinit.
  ///
  /// \return 0 si aucune touche n'a été appuyée
  /// \return Une valeur négative en cas d'erreur
  /// \return Une valeur positive si une touche est pressée
  /// \sa CSLP_GetChar()
  ///////////////////////////////////////////////////////////
  int DLL_IMPEXP CSLP_PollChar();

  ///////////////////////////////////////////////////////////
  /// Permet de récupérer la touche pressée par l'utilisateur.\n
  /// Cette fonction est à appeler après la fonction PollChar()
  /// si celle-ci a retournée une valeur positive. Cette fonction
  /// est non bloquante.\n
  ///
  /// \return 0 en cas d'erreur
  /// \return Le code du caractère en cas de succès
  /// \sa CSLP_PollChar()
  ///////////////////////////////////////////////////////////
  int DLL_IMPEXP CSLP_GetChar();

# ifdef __cplusplus
}
# endif /* __cplusplus */

#endif /* !CSLP_INPUT_HEADER */
